<!DOCTYPE html>
<html lang="en">
<head>
    <meta charset="utf-8">
    <title>JSDoc: Class: video</title>

    <script src="scripts/prettify/prettify.js"> </script>
    <script src="scripts/prettify/lang-css.js"> </script>
    <!--[if lt IE 9]>
      <script src="//html5shiv.googlecode.com/svn/trunk/html5.js"></script>
    <![endif]-->
    <link type="text/css" rel="stylesheet" href="styles/prettify-tomorrow.css">
    <link type="text/css" rel="stylesheet" href="styles/jsdoc-default.css">
</head>

<body>

<div id="main">

    <h1 class="page-title">Class: video</h1>

    




<section>

<header>
    
        <h2>
        video
        </h2>
        
    
</header>

<article>
    <div class="container-overview">
    
        

    

    <h4 class="name" id="video"><span class="type-signature"></span>new video<span class="signature">(id)</span><span class="type-signature"></span></h4>

    



<div class="description">
    Creates a video object
</div>









    <h5>Parameters:</h5>
    

<table class="params">
    <thead>
    <tr>
        
        <th>Name</th>
        

        <th>Type</th>

        

        

        <th class="last">Description</th>
    </tr>
    </thead>

    <tbody>
    

        <tr>
            
                <td class="name"><code>id</code></td>
            

            <td class="type">
            
                
<span class="param-type">string</span>


            
            </td>

            

            

            <td class="description last">The id of the dom element containing the video</td>
        </tr>

    
    </tbody>
</table>






<dl class="details">

    

    

    

    

    

    

    

    

    

    

    

    

    
    <dt class="tag-source">Source:</dt>
    <dd class="tag-source"><ul class="dummy"><li>
        <a href="video.js.html">video.js</a>, <a href="video.js.html#line12">line 12</a>
    </li></ul></dd>
    

    

    

    
</dl>
















    
    </div>

    

    

    

     

    

    

    
        <h3 class="subsection-title">Methods</h3>

        
            

    

    <h4 class="name" id="GetAvailHeight"><span class="type-signature"></span>GetAvailHeight<span class="signature">()</span><span class="type-signature"></span></h4>

    



<div class="description">
    gets available height (6.14.06)
</div>













<dl class="details">

    

    

    

    

    

    

    

    

    

    

    

    

    
    <dt class="tag-source">Source:</dt>
    <dd class="tag-source"><ul class="dummy"><li>
        <a href="video.js.html">video.js</a>, <a href="video.js.html#line241">line 241</a>
    </li></ul></dd>
    

    

    

    
</dl>
















        
            

    

    <h4 class="name" id="GetAvailWidth"><span class="type-signature"></span>GetAvailWidth<span class="signature">()</span><span class="type-signature"></span></h4>

    



<div class="description">
    gets available width (6.14.06)
</div>













<dl class="details">

    

    

    

    

    

    

    

    

    

    

    

    

    
    <dt class="tag-source">Source:</dt>
    <dd class="tag-source"><ul class="dummy"><li>
        <a href="video.js.html">video.js</a>, <a href="video.js.html#line235">line 235</a>
    </li></ul></dd>
    

    

    

    
</dl>
















        
            

    

    <h4 class="name" id="GetDirName"><span class="type-signature"></span>GetDirName<span class="signature">()</span><span class="type-signature"></span></h4>

    



<div class="description">
    Gets mode
</div>













<dl class="details">

    

    

    

    

    

    

    

    

    

    

    

    

    
    <dt class="tag-source">Source:</dt>
    <dd class="tag-source"><ul class="dummy"><li>
        <a href="video.js.html">video.js</a>, <a href="video.js.html#line334">line 334</a>
    </li></ul></dd>
    

    

    

    
</dl>
















        
            

    

    <h4 class="name" id="GetFileInfo"><span class="type-signature"></span>GetFileInfo<span class="signature">()</span><span class="type-signature"></span></h4>

    



<div class="description">
    Returns self object in order to be compliant with the functions from file_info
</div>













<dl class="details">

    

    

    

    

    

    

    

    

    

    

    

    

    
    <dt class="tag-source">Source:</dt>
    <dd class="tag-source"><ul class="dummy"><li>
        <a href="video.js.html">video.js</a>, <a href="video.js.html#line65">line 65</a>
    </li></ul></dd>
    

    

    

    
</dl>
















        
            

    

    <h4 class="name" id="GetFullName"><span class="type-signature"></span>GetFullName<span class="signature">()</span><span class="type-signature"></span></h4>

    



<div class="description">
    Gets full image name
</div>













<dl class="details">

    

    

    

    

    

    

    

    

    

    

    

    

    
    <dt class="tag-source">Source:</dt>
    <dd class="tag-source"><ul class="dummy"><li>
        <a href="video.js.html">video.js</a>, <a href="video.js.html#line349">line 349</a>
    </li></ul></dd>
    

    

    

    
</dl>
















        
            

    

    <h4 class="name" id="GetImagePath"><span class="type-signature"></span>GetImagePath<span class="signature">()</span><span class="type-signature"></span></h4>

    



<div class="description">
    Gets image path
</div>













<dl class="details">

    

    

    

    

    

    

    

    

    

    

    

    

    
    <dt class="tag-source">Source:</dt>
    <dd class="tag-source"><ul class="dummy"><li>
        <a href="video.js.html">video.js</a>, <a href="video.js.html#line344">line 344</a>
    </li></ul></dd>
    

    

    

    
</dl>
















        
            

    

    <h4 class="name" id="GetImName"><span class="type-signature"></span>GetImName<span class="signature">()</span><span class="type-signature"></span></h4>

    



<div class="description">
    Gets image name
</div>













<dl class="details">

    

    

    

    

    

    

    

    

    

    

    

    

    
    <dt class="tag-source">Source:</dt>
    <dd class="tag-source"><ul class="dummy"><li>
        <a href="video.js.html">video.js</a>, <a href="video.js.html#line339">line 339</a>
    </li></ul></dd>
    

    

    

    
</dl>
















        
            

    

    <h4 class="name" id="GetImRatio"><span class="type-signature"></span>GetImRatio<span class="signature">()</span><span class="type-signature"></span></h4>

    



<div class="description">
    Returns the ratio of the available width/height to the original
width/height. For now, it is always 1
</div>













<dl class="details">

    

    

    

    

    

    

    

    

    

    

    

    

    
    <dt class="tag-source">Source:</dt>
    <dd class="tag-source"><ul class="dummy"><li>
        <a href="video.js.html">video.js</a>, <a href="video.js.html#line60">line 60</a>
    </li></ul></dd>
    

    

    

    
</dl>
















        
            

    

    <h4 class="name" id="GetInterpolatedPoints"><span class="type-signature"></span>GetInterpolatedPoints<span class="signature">(xinit, yinit, xend, yend, tinit, tend, tcurrent)</span><span class="type-signature"></span></h4>

    



<div class="description">
    Computes a set of points representing a linearly interpolated polygon.
</div>









    <h5>Parameters:</h5>
    

<table class="params">
    <thead>
    <tr>
        
        <th>Name</th>
        

        <th>Type</th>

        

        

        <th class="last">Description</th>
    </tr>
    </thead>

    <tbody>
    

        <tr>
            
                <td class="name"><code>xinit</code></td>
            

            <td class="type">
            
                
<span class="param-type">array</span>


            
            </td>

            

            

            <td class="description last">xcoordinates of the polygon at tinit</td>
        </tr>

    

        <tr>
            
                <td class="name"><code>yinit</code></td>
            

            <td class="type">
            
                
<span class="param-type">array</span>


            
            </td>

            

            

            <td class="description last">ycoordinates of the polygon at tinit</td>
        </tr>

    

        <tr>
            
                <td class="name"><code>xend</code></td>
            

            <td class="type">
            
                
<span class="param-type">array</span>


            
            </td>

            

            

            <td class="description last">xcoordinates of the polygon at tend</td>
        </tr>

    

        <tr>
            
                <td class="name"><code>yend</code></td>
            

            <td class="type">
            
                
<span class="param-type">array</span>


            
            </td>

            

            

            <td class="description last">ycoordinates of the polygon at tend</td>
        </tr>

    

        <tr>
            
                <td class="name"><code>tinit</code></td>
            

            <td class="type">
            
                
<span class="param-type">int</span>


            
            </td>

            

            

            <td class="description last">first ground truth frame number</td>
        </tr>

    

        <tr>
            
                <td class="name"><code>tend</code></td>
            

            <td class="type">
            
                
<span class="param-type">int</span>


            
            </td>

            

            

            <td class="description last">last ground truth frame number</td>
        </tr>

    

        <tr>
            
                <td class="name"><code>tcurrent</code></td>
            

            <td class="type">
            
                
<span class="param-type">int</span>


            
            </td>

            

            

            <td class="description last">frame that has to be interpolated</td>
        </tr>

    
    </tbody>
</table>






<dl class="details">

    

    

    

    

    

    

    

    

    

    

    

    

    
    <dt class="tag-source">Source:</dt>
    <dd class="tag-source"><ul class="dummy"><li>
        <a href="video.js.html">video.js</a>, <a href="video.js.html#line381">line 381</a>
    </li></ul></dd>
    

    

    

    
</dl>
















        
            

    

    <h4 class="name" id="GetNewVideo"><span class="type-signature"></span>GetNewVideo<span class="signature">()</span><span class="type-signature"></span></h4>

    



<div class="description">
    Fetches a new video based on the URL string. Creates a div container to store the video
</div>













<dl class="details">

    

    

    

    

    

    

    

    

    

    

    

    

    
    <dt class="tag-source">Source:</dt>
    <dd class="tag-source"><ul class="dummy"><li>
        <a href="video.js.html">video.js</a>, <a href="video.js.html#line41">line 41</a>
    </li></ul></dd>
    

    

    

    
</dl>
















        
            

    

    <h4 class="name" id="GetTemplatePath"><span class="type-signature"></span>GetTemplatePath<span class="signature">()</span><span class="type-signature"></span></h4>

    



<div class="description">
    Gets template path
</div>













<dl class="details">

    

    

    

    

    

    

    

    

    

    

    

    

    
    <dt class="tag-source">Source:</dt>
    <dd class="tag-source"><ul class="dummy"><li>
        <a href="video.js.html">video.js</a>, <a href="video.js.html#line354">line 354</a>
    </li></ul></dd>
    

    

    

    
</dl>
















        
            

    

    <h4 class="name" id="GetURLField"><span class="type-signature"></span>GetURLField<span class="signature">()</span><span class="type-signature"></span></h4>

    



<div class="description">
    String is assumed to have field=value form.  Parses string to
    return the field.
</div>













<dl class="details">

    

    

    

    

    

    

    

    

    

    

    

    

    
    <dt class="tag-source">Source:</dt>
    <dd class="tag-source"><ul class="dummy"><li>
        <a href="video.js.html">video.js</a>, <a href="video.js.html#line361">line 361</a>
    </li></ul></dd>
    

    

    

    
</dl>
















        
            

    

    <h4 class="name" id="GetURLValue"><span class="type-signature"></span>GetURLValue<span class="signature">()</span><span class="type-signature"></span></h4>

    



<div class="description">
    String is assumed to have field=value form.  Parses string to
    return the value.
</div>













<dl class="details">

    

    

    

    

    

    

    

    

    

    

    

    

    
    <dt class="tag-source">Source:</dt>
    <dd class="tag-source"><ul class="dummy"><li>
        <a href="video.js.html">video.js</a>, <a href="video.js.html#line368">line 368</a>
    </li></ul></dd>
    

    

    

    
</dl>
















        
            

    

    <h4 class="name" id="IsFitImage"><span class="type-signature"></span>IsFitImage<span class="signature">()</span><span class="type-signature"></span></h4>

    



<div class="description">
    Returns true if the image is zoomed to the original (fitted) resolution.
</div>













<dl class="details">

    

    

    

    

    

    

    

    

    

    

    

    

    
    <dt class="tag-source">Source:</dt>
    <dd class="tag-source"><ul class="dummy"><li>
        <a href="video.js.html">video.js</a>, <a href="video.js.html#line252">line 252</a>
    </li></ul></dd>
    

    

    

    
</dl>
















        
            

    

    <h4 class="name" id="IsPointVisible"><span class="type-signature"></span>IsPointVisible<span class="signature">()</span><span class="type-signature"></span></h4>

    



<div class="description">
    Returns true if (x,y) is viewable.
</div>













<dl class="details">

    

    

    

    

    

    

    

    

    

    

    

    

    
    <dt class="tag-source">Source:</dt>
    <dd class="tag-source"><ul class="dummy"><li>
        <a href="video.js.html">video.js</a>, <a href="video.js.html#line257">line 257</a>
    </li></ul></dd>
    

    

    

    
</dl>
















        
            

    

    <h4 class="name" id="ParseURL"><span class="type-signature"></span>ParseURL<span class="signature">()</span><span class="type-signature"></span></h4>

    



<div class="description">
    Parses url again, knowing that is a video. The function is almost a replica of that in file_info
</div>













<dl class="details">

    

    

    

    

    

    

    

    

    

    

    

    

    
    <dt class="tag-source">Source:</dt>
    <dd class="tag-source"><ul class="dummy"><li>
        <a href="video.js.html">video.js</a>, <a href="video.js.html#line270">line 270</a>
    </li></ul></dd>
    

    

    

    
</dl>
















        
            

    

    <h4 class="name" id="ScaleFrame"><span class="type-signature"></span>ScaleFrame<span class="signature">()</span><span class="type-signature"></span></h4>

    



<div class="description">
    Tells the picture to take up the available space in the browser, if it needs it. 6.29.06
</div>













<dl class="details">

    

    

    

    

    

    

    

    

    

    

    

    

    
    <dt class="tag-source">Source:</dt>
    <dd class="tag-source"><ul class="dummy"><li>
        <a href="video.js.html">video.js</a>, <a href="video.js.html#line202">line 202</a>
    </li></ul></dd>
    

    

    

    
</dl>
















        
            

    

    <h4 class="name" id="ScrollbarsOff"><span class="type-signature"></span>ScrollbarsOff<span class="signature">()</span><span class="type-signature"></span></h4>

    



<div class="description">
    Turn off image scrollbars if zoomed in.
</div>













<dl class="details">

    

    

    

    

    

    

    

    

    

    

    

    

    
    <dt class="tag-source">Source:</dt>
    <dd class="tag-source"><ul class="dummy"><li>
        <a href="video.js.html">video.js</a>, <a href="video.js.html#line118">line 118</a>
    </li></ul></dd>
    

    

    

    
</dl>
















        
            

    

    <h4 class="name" id="ScrollbarsOn"><span class="type-signature"></span>ScrollbarsOn<span class="signature">()</span><span class="type-signature"></span></h4>

    



<div class="description">
    Turn on image scrollbars if zoomed in.
</div>













<dl class="details">

    

    

    

    

    

    

    

    

    

    

    

    

    
    <dt class="tag-source">Source:</dt>
    <dd class="tag-source"><ul class="dummy"><li>
        <a href="video.js.html">video.js</a>, <a href="video.js.html#line126">line 126</a>
    </li></ul></dd>
    

    

    

    
</dl>
















        
            

    

    <h4 class="name" id="SetImageDimensions"><span class="type-signature"></span>SetImageDimensions<span class="signature">()</span><span class="type-signature"></span></h4>

    



<div class="description">
    Sets the dimensions of the image based on browser setup. For now it sets 640x480
</div>













<dl class="details">

    

    

    

    

    

    

    

    

    

    

    

    

    
    <dt class="tag-source">Source:</dt>
    <dd class="tag-source"><ul class="dummy"><li>
        <a href="video.js.html">video.js</a>, <a href="video.js.html#line71">line 71</a>
    </li></ul></dd>
    

    

    

    
</dl>
















        
            

    

    <h4 class="name" id="SetOrigImDims"><span class="type-signature"></span>SetOrigImDims<span class="signature">(im)</span><span class="type-signature"></span></h4>

    



<div class="description">
    Retrieves and sets the original image's dimensions (width/height).
</div>









    <h5>Parameters:</h5>
    

<table class="params">
    <thead>
    <tr>
        
        <th>Name</th>
        

        <th>Type</th>

        

        

        <th class="last">Description</th>
    </tr>
    </thead>

    <tbody>
    

        <tr>
            
                <td class="name"><code>im</code></td>
            

            <td class="type">
            
                
<span class="param-type"><a href="image.html">image</a></span>


            
            </td>

            

            

            <td class="description last"></td>
        </tr>

    
    </tbody>
</table>






<dl class="details">

    

    

    

    

    

    

    

    

    

    

    

    

    
    <dt class="tag-source">Source:</dt>
    <dd class="tag-source"><ul class="dummy"><li>
        <a href="video.js.html">video.js</a>, <a href="video.js.html#line228">line 228</a>
    </li></ul></dd>
    

    

    

    
</dl>
















        
            

    

    <h4 class="name" id="SlideWindow"><span class="type-signature"></span>SlideWindow<span class="signature">(x, y)</span><span class="type-signature"> &rarr; {intarray}</span></h4>

    



<div class="description">
    If (x,y) is not in view, then scroll it into view.  Return adjusted
(x,y) point that takes into account the slide offset.
</div>









    <h5>Parameters:</h5>
    

<table class="params">
    <thead>
    <tr>
        
        <th>Name</th>
        

        <th>Type</th>

        

        

        <th class="last">Description</th>
    </tr>
    </thead>

    <tbody>
    

        <tr>
            
                <td class="name"><code>x</code></td>
            

            <td class="type">
            
                
<span class="param-type">int</span>


            
            </td>

            

            

            <td class="description last"></td>
        </tr>

    

        <tr>
            
                <td class="name"><code>y</code></td>
            

            <td class="type">
            
                
<span class="param-type">int</span>


            
            </td>

            

            

            <td class="description last"></td>
        </tr>

    
    </tbody>
</table>






<dl class="details">

    

    

    

    

    

    

    

    

    

    

    

    

    
    <dt class="tag-source">Source:</dt>
    <dd class="tag-source"><ul class="dummy"><li>
        <a href="video.js.html">video.js</a>, <a href="video.js.html#line106">line 106</a>
    </li></ul></dd>
    

    

    

    
</dl>













<h5>Returns:</h5>

        


<dl>
    <dt>
        Type
    </dt>
    <dd>
        
<span class="param-type">intarray</span>


    </dd>
</dl>

    



        
            

    

    <h4 class="name" id="SubmitEditObject"><span class="type-signature"></span>SubmitEditObject<span class="signature">()</span><span class="type-signature"></span></h4>

    



<div class="description">
    Submits an edited object, stored in select_anno
</div>













<dl class="details">

    

    

    

    

    

    

    

    

    

    

    

    

    
    <dt class="tag-source">Source:</dt>
    <dd class="tag-source"><ul class="dummy"><li>
        <a href="video.js.html">video.js</a>, <a href="video.js.html#line464">line 464</a>
    </li></ul></dd>
    

    

    

    
</dl>
















        
            

    

    <h4 class="name" id="SubmitObject"><span class="type-signature"></span>SubmitObject<span class="signature">()</span><span class="type-signature"></span></h4>

    



<div class="description">
    Submits an object for the first time. It is the equivalent of SubmitQuery for video
</div>













<dl class="details">

    

    

    

    

    

    

    

    

    

    

    

    

    
    <dt class="tag-source">Source:</dt>
    <dd class="tag-source"><ul class="dummy"><li>
        <a href="video.js.html">video.js</a>, <a href="video.js.html#line513">line 513</a>
    </li></ul></dd>
    

    

    

    
</dl>
















        
            

    

    <h4 class="name" id="UpdateObjectPosition"><span class="type-signature"></span>UpdateObjectPosition<span class="signature">(anno)</span><span class="type-signature"></span></h4>

    



<div class="description">
    Update the position of an annotation. Modifies the xml file information about a given annotation.
</div>









    <h5>Parameters:</h5>
    

<table class="params">
    <thead>
    <tr>
        
        <th>Name</th>
        

        <th>Type</th>

        

        

        <th class="last">Description</th>
    </tr>
    </thead>

    <tbody>
    

        <tr>
            
                <td class="name"><code>anno</code></td>
            

            <td class="type">
            
                
<span class="param-type">annotation</span>


            
            </td>

            

            

            <td class="description last">annotation containing the info about the polygon</td>
        </tr>

    
    </tbody>
</table>






<dl class="details">

    

    

    

    

    

    

    

    

    

    

    

    

    
    <dt class="tag-source">Source:</dt>
    <dd class="tag-source"><ul class="dummy"><li>
        <a href="video.js.html">video.js</a>, <a href="video.js.html#line395">line 395</a>
    </li></ul></dd>
    

    

    

    
</dl>
















        
            

    

    <h4 class="name" id="Zoom"><span class="type-signature"></span>Zoom<span class="signature">()</span><span class="type-signature"></span></h4>

    



<div class="description">
    Not working now
</div>













<dl class="details">

    

    

    

    

    

    

    

    

    

    

    

    

    
    <dt class="tag-source">Source:</dt>
    <dd class="tag-source"><ul class="dummy"><li>
        <a href="video.js.html">video.js</a>, <a href="video.js.html#line133">line 133</a>
    </li></ul></dd>
    

    

    

    
</dl>
















        
    

    

    
</article>

</section>




</div>

<nav>
    <h2><a href="index.html">Home</a></h2><h3>Classes</h3><ul><li><a href="AdjustEvent.html">AdjustEvent</a></li><li><a href="canvas.html">canvas</a></li><li><a href="file_info.html">file_info</a></li><li><a href="image.html">image</a></li><li><a href="JSVideo.html">JSVideo</a></li><li><a href="video.html">video</a></li></ul><h3>Global</h3><ul><li><a href="global.html#AdjustPolygonButton">AdjustPolygonButton</a></li><li><a href="global.html#CreatePopupBubble">CreatePopupBubble</a></li><li><a href="global.html#CreatePopupBubbleCloseButton">CreatePopupBubbleCloseButton</a></li><li><a href="global.html#DrawCanvasClosePolygon">DrawCanvasClosePolygon</a></li><li><a href="global.html#DrawCanvasMouseDown">DrawCanvasMouseDown</a></li><li><a href="global.html#FinishStartup">FinishStartup</a></li><li><a href="global.html#getQueryVariable">getQueryVariable</a></li><li><a href="global.html#LMgetfield">LMgetfield</a></li><li><a href="global.html#LMnumberOfObjects">LMnumberOfObjects</a></li><li><a href="global.html#LoadAnnotation404">LoadAnnotation404</a></li><li><a href="global.html#LoadAnnotationSuccess">LoadAnnotationSuccess</a></li><li><a href="global.html#LoadTemplate404">LoadTemplate404</a></li><li><a href="global.html#LoadTemplateSuccess">LoadTemplateSuccess</a></li><li><a href="global.html#oVP">oVP</a></li><li><a href="global.html#SetAllAnnotationsArray">SetAllAnnotationsArray</a></li><li><a href="global.html#StartDrawEvent">StartDrawEvent</a></li><li><a href="global.html#StartEditEvent">StartEditEvent</a></li><li><a href="global.html#StartEditVideoEvent">StartEditVideoEvent</a></li><li><a href="global.html#StartupLabelMe">StartupLabelMe</a></li><li><a href="global.html#StopDrawEvent">StopDrawEvent</a></li><li><a href="global.html#StopEditEvent">StopEditEvent</a></li><li><a href="global.html#UndoCloseButton">UndoCloseButton</a></li></ul>
</nav>

<br class="clear">

<footer>
    Documentation generated by <a href="https://github.com/jsdoc3/jsdoc">JSDoc 3.4.0-dev</a> on Thu Mar 12 2015 11:35:01 GMT-0700 (PDT)
</footer>

<script> prettyPrint(); </script>
<script src="scripts/linenumber.js"> </script>
</body>
</html>